home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il_c / ilStereoView.z / ilStereoView
Encoding:
Text File  |  2002-10-03  |  12.1 KB  |  265 lines
  1.  
  2.  
  3.  
  4. iiiillllSSSStttteeeerrrreeeeooooVVVViiiieeeewwww((((3333))))    IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll    iiiillllSSSStttteeeerrrreeeeooooVVVViiiieeeewwww((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllSSSStttteeeerrrreeeeooooVVVViiiieeeewwww - displays a stereo image
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilView
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilStereoView.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      ilStereoView is derived from ilView and provides the ability to render a
  19.      stereo image. It is created like ilView but takes two images (left and
  20.      right) instead of one. Stereo is only supported on InfiniteReality,
  21.      RealityEngine, and Impact graphics systems in OpenGL render mode (see the
  22.      man pages, ilDisplay and ilGLDisplayImg, for more details).
  23.  
  24.      A stereo buffer must be allocated with ilGLXConfig or GLXConfig for
  25.      mixed-model applications or with stereobuffer for GL applications.  The
  26.      left image is rendered into the left buffer and the right image is
  27.      rendered into the right buffer. By default, only the left buffer is
  28.      displayed.  Note that the application must set the stereo video output
  29.      format with the /usr/gfx/setmon command.  When in stereo video mode, both
  30.      buffers are alternately displayed.
  31.  
  32.  
  33. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  34.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  35.  
  36.           ilStereoView *ilStereoViewCreate(ilDisplay* disply,
  37.                         ilImage* LImg, ilImage* RImg, int mode)
  38.           ilStereoView *ilStereoViewZCreate(ilDisplay* disply, ilImage* zImg,
  39.                         int zLeft, int zRight, int mode)
  40.  
  41.      DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  42.  
  43.           void ilStereoViewDelete(ilStereoView* stView)
  44.  
  45.      QQQQuuuueeeerrrryyyyiiiinnnngggg PPPPrrrrooooppppeeeerrrrttttiiiieeeessss
  46.  
  47.           ilImage *ilStereoViewGetLImg(ilStereoView* stView)
  48.           ilImage *ilStereoViewGetRImg(ilStereoView* stView)
  49.           int ilStereoViewIsStereo(ilStereoView* view)
  50.  
  51.      SSSSeeeettttttttiiiinnnngggg CCCCoooonnnnffffiiiigggguuuurrrraaaattttiiiioooonnnn
  52.  
  53.           void *ilStereoViewSetLIndex(ilStereoView* stView, float zIdx)
  54.           void *ilStereoViewSetRIndex(ilStereoView* stView, float zIdx)
  55.  
  56.           void *ilStereoViewAdjLImg(ilStereoView* stView, float delX, float delY)
  57.           void *ilStereoViewAdjRImg(ilStereoView* stView, float delX, float delY)
  58.           ilStatus ilStereoViewsetDrawImgID(int imgID = ilStereoViewImgBoth)
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllSSSStttteeeerrrreeeeooooVVVViiiieeeewwww((((3333))))    IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll    iiiillllSSSStttteeeerrrreeeeooooVVVViiiieeeewwww((((3333))))
  71.  
  72.  
  73.  
  74. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  75.      iiiillllSSSStttteeeerrrreeeeooooVVVViiiieeeewwww(((())))
  76.  
  77.           ilStereoView *ilStereoViewCreate(ilDisplay* disply, ilImage* LImg,
  78.                                ilImage* RImg, int mode)
  79.           ilStereoView *ilStereoViewZCreate(ilDisplay* disply, ilImage* zImg,
  80.                                 int zLeft, int zRight, int mode)
  81.  
  82.  
  83.           Both versions of the ilStereoView constructor take a pointer to the
  84.           ilDisplay that will manage it. The first version of the constructor,
  85.           also takes pointers _L_I_m_g and _R_I_m_g for the left and right images
  86.           respectively. The second version of the constructor, takes a single
  87.           image pointer _z_I_m_g. In addition, two indexes _z_L_e_f_t and _z_R_i_g_h_t,
  88.           specify the Z index into _z_I_m_g corresponding to the left and right
  89.           images. The advantange of this approach is that a single IL chain
  90.           can be used to process the stereo-pair rather than having a chain
  91.           for each image.
  92.  
  93.           The left image is rendered into the left buffer and the right image
  94.           is rendered into the right buffer. The stereo video output formats
  95.           on InfiniteReality, RealityEngine and Impact present the left buffer
  96.           to the left eye and the right buffer to the right eye.  The _m_o_d_e
  97.           parameter has the same functionality as in ilView, allowing ilClip
  98.           to be specified for example.
  99.  
  100.      iiiillllSSSStttteeeerrrreeeeooooVVVViiiieeeewwwwDDDDeeeelllleeeetttteeee
  101.  
  102.           void ilStereoViewDelete(ilStereoView* stView)
  103.  
  104.  
  105.           Removes and deletes all of the allocated pointers and items used by
  106.           the ilStereoView.
  107.  
  108.      aaaaddddjjjjLLLLIIIImmmmgggg(((())))
  109.  
  110.           void ilStereoViewAdjLImg(ilStereoView* stView, float delX, float delY)
  111.  
  112.  
  113.           Adjusts the left image by _d_e_l_X and _d_e_l_Y pixels.  Note the deltas are
  114.           floats to allow for fractional adjustments.  (lower left coordinate
  115.           orientation is assumed.)
  116.  
  117.      aaaaddddjjjjRRRRIIIImmmmgggg(((())))
  118.  
  119.           void ilStereoViewAdjRImg(ilStereoView* stView, float delX, float delY)
  120.  
  121.  
  122.           Adjusts the right image by _d_e_l_X and _d_e_l_Y pixels.  Note the deltas
  123.           are floats to allow for fractional adjustments.  (lower left
  124.           coordinate orientation is assumed.)
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllSSSStttteeeerrrreeeeooooVVVViiiieeeewwww((((3333))))    IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll    iiiillllSSSStttteeeerrrreeeeooooVVVViiiieeeewwww((((3333))))
  137.  
  138.  
  139.  
  140.      ggggeeeettttLLLLIIIImmmmgggg(((())))
  141.  
  142.           ilImage *ilStereoViewGetLImg(ilStereoView* stView)
  143.  
  144.  
  145.           Returns a pointer to the left image. The left image is rendered into
  146.           the left buffer.
  147.  
  148.      ggggeeeettttRRRRIIIImmmmgggg(((())))
  149.  
  150.           ilImage *ilStereoViewGetRImg(ilStereoView* stView)
  151.  
  152.  
  153.           Returns a pointer to the right image. The right image is rendered
  154.           into the rightbuffer.
  155.  
  156.      iiiissssSSSStttteeeerrrreeeeoooo(((())))
  157.  
  158.           int ilStereoViewIsStereo(ilStereoView* view)
  159.  
  160.  
  161.           Always returns TRUE for stereo views.
  162.  
  163.      sssseeeettttDDDDrrrraaaawwwwnnnnIIIImmmmgggg(((())))
  164.  
  165.           ilStatus ilStereoViewSetDrawnImg(int imgID = ilStereoViewImgBoth)
  166.  
  167.  
  168.           Sets the drawn image in the stereo view to the given imgID. The
  169.           imgID argument may be one of ilStereoViewImgLeft,
  170.           ilStereoViewImgRight or ilStereoViewImgBoth to indicate that the
  171.           left image, right image or both images are to be rendered,
  172.           respectively. In the case that a single image is selected for
  173.           rendering, that image will be drawn to both left and right buffers
  174.           to create a monoscopic view of that single image.
  175.  
  176.      sssseeeettttLLLLIIIInnnnddddeeeexxxx(((())))
  177.  
  178.           ilImage *ilStereoViewSetLIndex(ilStereoView* stView, float zIdx)
  179.  
  180.  
  181.           Sets the Z index corresponding to the left image to _z_I_d_x.
  182.  
  183.      sssseeeettttRRRRIIIInnnnddddeeeexxxx(((())))
  184.  
  185.           ilImage *ilStereoViewSetRIndex(ilStereoView* stView, float zIdx)
  186.  
  187.  
  188.           Sets the Z index corresponding to the right image to _z_I_d_x.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. iiiillllSSSStttteeeerrrreeeeooooVVVViiiieeeewwww((((3333))))    IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll    iiiillllSSSStttteeeerrrreeeeooooVVVViiiieeeewwww((((3333))))
  203.  
  204.  
  205.  
  206. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  207.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllVVVViiiieeeewwww
  208.      ilViewAlignImg(), ilViewAlignView(), ilViewDisplay(),
  209.      ilViewEnableBorderCallback(), ilViewEnableCallback(), ilViewFindEdge(),
  210.      ilViewGetBackground(), ilViewGetBorderCallback(), ilViewGetBorderColor(),
  211.      ilViewGetBorderStyle(), ilViewGetBorderWidth(), ilViewGetBorders(),
  212.      ilViewGetCallback(), ilViewGetDisplay(), ilViewGetErrorColor(),
  213.      ilViewGetImg(), ilViewGetImgLoc(), ilViewGetImgPos3D(),
  214.      ilViewGetImgPos(), ilViewGetImgSize3D(), ilViewGetImgSize(),
  215.      ilViewGetLoc(), ilViewGetLocMode(), ilViewGetPixel(), ilViewGetPos(),
  216.      ilViewGetSize(), ilViewGetXImg(), ilViewGetZ(), ilViewHasBorders(),
  217.      ilViewIsAutoCentered(), ilViewIsBorderCallbackEnabled(),
  218.      ilViewIsCallbackEnabled(), ilViewIsDefer(), ilViewIsNop(),
  219.      ilViewIsSelected(), ilViewIsStaticUpdate(), ilViewIsStereoView(),
  220.      ilViewMoveImg(), ilViewMoveView(), ilViewPaint(), ilViewQPaint(),
  221.      ilViewResize(), ilViewSave(), ilViewSelect(), ilViewSetAutoCenter(),
  222.      ilViewSetAutoStaticUpdate(), ilViewSetBackground(),
  223.      ilViewSetBorderCallback(), ilViewSetBorderColor(),
  224.      ilViewSetBorderStyle(), ilViewSetBorderWidth(), ilViewSetBorders(),
  225.      ilViewSetCallback(), ilViewSetDefer(), ilViewSetErrorColor(),
  226.      ilViewSetImg(), ilViewSetLoc(), ilViewSetLocMode(), ilViewSetNop(),
  227.      ilViewSetPixel(), ilViewSetStaticUpdate(), ilViewSetXImg(), ilViewSetZ(),
  228.      ilViewSplit(), ilViewUnselect(), ilViewUpdate(), ilViewWipe(),
  229.      ilViewWipeSize(), ilViewWipeSplit()
  230.  
  231.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllLLLLiiiinnnnkkkk
  232.      ilLinkClearSet(), ilLinkClearStatus(), ilLinkGetDescription(),
  233.      ilLinkGetDirectParent(), ilLinkGetDisabledIndex(), ilLinkGetFloatProp(),
  234.      ilLinkGetGenerationID(), ilLinkGetIntProp(), ilLinkGetNumChildren(),
  235.      ilLinkGetNumParents(), ilLinkGetParent(), ilLinkGetPtrProp(),
  236.      ilLinkGetRelatedChild(), ilLinkGetRelatedDelete(),
  237.      ilLinkGetRelatedType(), ilLinkGetStatus(), ilLinkIsAllowed(),
  238.      ilLinkIsAltered(), ilLinkIsEnabled(), ilLinkIsRelated(), ilLinkIsSet(),
  239.      ilLinkRemoveParent(), ilLinkRemoveProp(), ilLinkSetDescription(),
  240.      ilLinkSetDisabledIndex(), ilLinkSetEnabled(), ilLinkSetParent(),
  241.      ilLinkSetProp(), ilLinkSetRelatedDelete(), ilLinkSetRelatedType()
  242.  
  243. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  244.      ilDisplay, ilView, setmon
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.